Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.api/Networks

Networks

class Networks(dockerClient: DockerClient)

Docker networks operations using the owning DockerClient.

Result-returning methods report daemon HTTP errors as ErrorResponse. Transport/decoding failures and cancellation can throw. Live flows report request failures during collection.

Constructors

Networks

constructor(dockerClient: DockerClient)

Functions

connect

suspend fun connect(id: String, connectionConfig: NetworkConnectRequest): Result<Unit, ErrorResponse>

Connect a container to a network

create

suspend fun create(networkConfig: NetworkCreateRequest): Result<NetworkCreateResponse, ErrorResponse>

Create a network

disconnect

suspend fun disconnect(id: String, connectionConfig: NetworkDisconnectRequest): Result<Unit, ErrorResponse>

Disconnect a container from a network

inspect

suspend fun inspect(id: String, verbose: Boolean = false, scope: String? = null): Result<Network, ErrorResponse>

Inspect a network

list

suspend fun list(filters: Map<String, List<String>>? = null): Result<List<Network>, ErrorResponse>

List networks

prune

suspend fun prune(filters: Map<String, List<String>>? = null): Result<NetworkPruneResponse, ErrorResponse>

Delete unused networks

remove

suspend fun remove(id: String): Result<Unit, ErrorResponse>

Deletes a network; disconnect attached containers first when required by Docker.